home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 21 / AACD 21.iso / AACD / Programming / Scalos / Developer / Autodoc / iconobject.doc < prev    next >
Encoding:
Text File  |  1998-01-04  |  3.8 KB  |  173 lines
  1. TABLE OF CONTENTS
  2.  
  3. iconobject.library/--background
  4. iconobject.library/NewIconObject
  5. iconobject.library/DisposeIconObject
  6. iconobject.library/GetDefIconObject
  7. iconobject.library/PutIconObject
  8. iconobject.library/IsIconName
  9. iconobject.library/Convert2IconObject
  10.  
  11.  
  12. --background
  13.     This library is an interface to the iconobject.datatype. Normaly
  14.     it has comparable functions to icon.library. It was written because
  15.     the datatypes.library was so slow while scaning the datatypes.
  16.  
  17.     NAME
  18.     NewIconObject
  19.  
  20.     SYNOPSIS
  21.     iconobject NewIconObject (Name, Taglist)
  22.                                A0      A1
  23.  
  24.     struct iconobject NewIconObject ( APTR Name , APTR Taglist );
  25.  
  26.     FUNCTION
  27.     Reads an icon from disk. It cannot be use for drawings before a
  28.     IDTM_Layout method was used.
  29.  
  30.     INPUTS
  31.     Name - the filename (without an extention like .info)
  32.     Taglist -
  33.         IDTA_Text - text under the icon
  34.         IDTA_InnerLeft
  35.         IDTA_InnerTop
  36.         IDTA_InnerRight
  37.         IDTA_InnerBottom - offset from iconimage inside of the icon
  38.         IDTA_FrameType - type of frame around the icon
  39.         IDTA_TextPen - Outline pen for the icontext
  40.         IDTA_TextMode - textmode
  41.             IDTV_TextMode_Normal - standard text
  42.             IDTV_TextMode_Outline - outline text
  43.             IDTV_TextMode_Shadow - text with shadow (IDTA_TextPen
  44.                            is the shadow color)
  45.         IDTA_TextSkip - space between the icon and the text in pixels
  46.  
  47.     RESULT
  48.     iconobject - iconobject.datatype object or NULL if it fails to open
  49.              the icon
  50.  
  51.     SEE ALSO
  52.  
  53.  
  54.     NAME
  55.     DisposeIconObject
  56.  
  57.     SYNOPSIS
  58.     DisposeIconObject (iconobject)
  59.                            A0
  60.  
  61.     void DisposeIconObject ( struct iconobject );
  62.  
  63.     FUNCTION
  64.     Disposes the iconobject. It's similar to intuitions DisposeObject().
  65.  
  66.     INPUTS
  67.     iconobject - iconobject.datatype object
  68.  
  69.     RESULT
  70.  
  71.     SEE ALSO
  72.  
  73.  
  74.     NAME
  75.     GetDefIconObject
  76.  
  77.     SYNOPSIS
  78.     iconobject GetDefIconObject (IconType,TagList)
  79.                                     D0      A0
  80.  
  81.     struct iconobject GetDefIconObject ( ULONG IconType , APTR TagList );
  82.  
  83.     FUNCTION
  84.     Reads a default icon from ram or disk.
  85.  
  86.     INPUTS
  87.     IconType - diskobject icontype (see icon.library)
  88.     TagList - the same tags like NewIconObject and:
  89.         DTA_Name - you could give the icon a name
  90.  
  91.     RESULT
  92.     iconobject - iconobject.datatype object or NULL if it fails.
  93.  
  94.     NOTE
  95.  
  96.     SEE ALSO
  97.  
  98.  
  99.     NAME
  100.     PutIconObject
  101.  
  102.     SYNOPSIS
  103.     PutIconObject (iconobject,path,TagList)
  104.                        A0      A1    A2
  105.  
  106.     void PutIconObject ( struct iconobject, APTR path, APTR TagList );
  107.  
  108.     FUNCTION
  109.     Writes an icon to disk. This function sends the IDTM_Write method
  110.  
  111.     INPUTS
  112.     iconobject - iconobject.datatype object
  113.     path - the path for the icon (without an extention)
  114.     TagList -
  115.         ICONA_NoNewImage - don't change the image (the readed image
  116.                    will be rewritten)
  117.         ICONA_NoPosition - save a non-position icon
  118.         ICONA_NoUsePosition - use the current position of the icon-
  119.                       object
  120.  
  121.     RESULT
  122.  
  123.     SEE ALSO
  124.  
  125.  
  126.     NAME
  127.     IsIconName
  128.  
  129.     SYNOPSIS
  130.     pos IsIconName (filename)
  131.                        A0
  132.  
  133.     ULONG pos IsIconName ( APTR filename );
  134.  
  135.     FUNCTION
  136.     Checks if the given filename could be an icon, because you don't know
  137.     which extention it could have.
  138.  
  139.     INPUTS
  140.     filename - the path to check
  141.  
  142.     RESULT
  143.     pos - NULL if it's not an icon
  144.           ~0 if it's an icon, but it has no extention
  145.           >0 the position inside the filename where the extention begins
  146.  
  147.     SEE ALSO
  148.  
  149.  
  150.     NAME
  151.     Convert2IconObject
  152.  
  153.     SYNOPSIS
  154.     iconobject Convert2IconObject (diskobject)
  155.                                        A0
  156.  
  157.     struct iconobject Convert2IconObject ( struct diskobject );
  158.  
  159.     FUNCTION
  160.     Converts a icon.library - diskobject to a iconobject.datatype object.
  161.  
  162.     INPUTS
  163.     diskobject - icon.library - diskobject
  164.  
  165.     RESULT
  166.     iconobject - iconobject.datatype object
  167.  
  168.     NOTE
  169.     THIS FUNCTION IS PRIVATE! IT SHOULD NOT BE USED!
  170.  
  171.     SEE ALSO
  172.  
  173.